Android Scanbot Barcode SDK/io.scanbot.sdk.image

Package-level declarations

Types

data class BasicImageLoadOptions(var cropRect: Rect = Rect(), var canvasColor: CanvasColor = CanvasColor.WHITE) : Parcelable

Basic options for loading image.

BufferImageLoadOptions

data class BufferImageLoadOptions(var cropRect: Rect = Rect(), var colorConversion: ColorConversion = ColorConversion.ANY_COLOR, var canvasColor: CanvasColor = CanvasColor.WHITE, var loadMode: BufferLoadMode = BufferLoadMode.EAGER) : Parcelable

Options for loading image from buffer.

BufferLoadMode

enum BufferLoadMode : Enum<BufferLoadMode>

Image Ref Buffer Load Mode.

CanvasColor

enum CanvasColor : Enum<CanvasColor>

Canvas color to use when converting images with alpha channel to images without alpha channel.

ColorConversion

enum ColorConversion : Enum<ColorConversion>

Color conversion to apply during image loading.

EncodeImageOptions

data class EncodeImageOptions(var quality: Int = -1, var format: EncodingFormat = EncodingFormat.JPEG) : Parcelable

Options for encoding image.

EncodingFormat

enum EncodingFormat : Enum<EncodingFormat>

Image Encoding Format.

EncryptionMode

enum EncryptionMode : Enum<EncryptionMode>

Encryption/Decryption mode to be used when an image is loaded/saved.

ImageInfo

data class ImageInfo(var height: Int, var width: Int, var maxByteSize: Int) : Parcelable

Image Info.

ImageOrigin

enum ImageOrigin : Enum<ImageOrigin>

Location of the image origin in the image coordinate system.

ImageProfile

data class ImageProfile(var bitmapMemoryConsumption: Int = 0, var hibernationMemoryConsumption: Int = 0) : Parcelable

ImageRef profile part specific to image information.

ImageRef

class ImageRef(uniqueId: UUID?, acquireStrongReference: Boolean) : Parcelable, AutoCloseable

ImageRefPoolSnapshot

data class ImageRefPoolSnapshot(var imageRefProfiles: List<ImageRefProfile>, var totalMemoryConsumption: Long = 0) : Parcelable

Snapshot of all alive ImageRefs.

ImageRefPoolSnapshotsDiff

data class ImageRefPoolSnapshotsDiff(var totalMemoryConsumptionDiff: Long = 0, var removed: List<String>, var added: List<String>, var modified: List<String>) : Parcelable

difference between two snapshots.

ImageRefProfile

data class ImageRefProfile(var refInfo: RefCountedObjectProfile, var imageInfo: ImageProfile, var imageSource: ImageSource?) : Parcelable

ImageRef profile which provides detailed information about stored object.

ImageRotation

enum ImageRotation : Enum<ImageRotation>

Image rotation.

ImageSource

data class ImageSource(var type: ImageSourceType, var filePath: String?) : Parcelable

Description of source from which the ImageRef was created.

ImageSourceType

enum ImageSourceType : Enum<ImageSourceType>

The type of source which originated the underlying image.

PathImageLoadOptions

data class PathImageLoadOptions(var cropRect: Rect = Rect(), var colorConversion: ColorConversion = ColorConversion.ANY_COLOR, var canvasColor: CanvasColor = CanvasColor.WHITE, var loadMode: PathLoadMode = PathLoadMode.EAGER, var encryptionMode: EncryptionMode = EncryptionMode.AUTO, var decrypter: CoreStreamProvider? = null) : Parcelable

Options for loading image from path.

PathLoadMode

enum PathLoadMode : Enum<PathLoadMode>

Image Ref Path Load Mode.

RawImageLoadOptions

data class RawImageLoadOptions(var cropRect: Rect = Rect(), var origin: ImageOrigin = ImageOrigin.TOP_LEFT, var canvasColor: CanvasColor = CanvasColor.WHITE, var orientation: ImageRotation = ImageRotation.NONE) : Parcelable

Options for loading images that come from sensor.

SaveImageOptions

data class SaveImageOptions(var quality: Int = -1, var encryptionMode: EncryptionMode = EncryptionMode.AUTO, var encrypter: CoreStreamProvider? = null) : Parcelable

Options for saving image to a path.

ScanbotSdkImageRefProfiler

class ScanbotSdkImageRefProfiler

ImageRef memory profiler.

Functions

getIfValid

fun ImageRef.getIfValid(): ImageRef?

isValid

fun ImageRef.isValid(): Boolean